Cập nhật thông tin nhiều người dùng

API hỗ trợ tạo mới hoặc cập nhật thông tin nhiều users theo danh sách users được cung cấp.

HTTP request

POST https://{app_id}.api.piscale.com/user/v1.0/user/multi

Request header

Bảng mô tả tham số của request header:

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
X-Api-Key	string	API Key của ứng dụng	✓
X-Tenant-Id	string	Chỉ định tạo và cập nhật users cho tenant nào (ID bên hệ thống của bạn)	✗

Request body

Content-Type: application/json

Ví dụ

{
  "users" : [
    {
      "user_id": "49918031",
      "display_name": "Emily Johnson",
      "alias": "emily_johnson92",
      "avatar_url": "https://avatar-api.communi.io/a05b8b2d-a657-4f1c-965b-8ba94b91c20b/20b8582d-6beb-4161-b157-f7d2bf290962.png",
      "user_type_id": 1,
      "verified": true
    },
    {
      "user_id": "49918032",
      "display_name": "Emily Johnson 2",
      "alias": "emily_johnson92_2",
      "avatar_url": "https://avatar-api.communi.io/a05b8b2d-a657-4f1c-965b-8ba94b91c20b/20b8582d-6beb-4161-b157-f7d2bf290963.png",
      "user_type_id": 1,
      "verified": true
    }
  ]
}

Bảng mô tả thuộc tính:

Tên	Kiểu dữ liệu	Mô tả	Bắt buộc
users	array	Danh sách thông tin users cần tạo mới hoặc cập nhật, max 200 user	✓
users[i].user_id	string	Chỉ định ID duy nhất (ID bên hệ thống của bạn). Max 80 kí tự	✓
users[i].display_name	string	Tên hiển thị. Max 80 kí tự	✓
users[i].alias	string	Tên khác. Max 80 kí tự	✗
users[i].avatar_url	string	Đường dẫn dùng để hiển thị avatar. Max 2048 kí tự	✗
users[i].user_type_id	number	User Type ID của user, nếu không cung cấp sẽ không cập nhật User Type, mặc định type Default	✗
users[i].verified	bool	User được xác thực hay không	✗

Responses

Nếu thành công, API này trả về dữ liệu như sau:

Status: 200 OK

{
  "data": {
    "users": [
      {
        "user_id": "49918031",
        "ext_user_id": "6872016393206737",
        "tenant_id": "89915020",
        "ext_tenant_id": "6872016393176737",
        "display_name": "Emily Johnson",
        "alias": "emily_johnson92",
        "avatar_url": "https://avatar-api.communi.io/a05b8b2d-a657-4f1c-965b-8ba94b91c20b/20b8582d-6beb-4161-b157-f7d2bf290962.png",
        "status": 1,
        "type": 1,
        "verified": true
      },
      {
        "user_id": "49918032",
        "ext_user_id": "6872016393206738",
        "tenant_id": "89915020",
        "ext_tenant_id": "6872016393176737",
        "display_name": "Emily Johnson 2",
        "alias": "emily_johnson92_2",
        "avatar_url": "https://avatar-api.communi.io/a05b8b2d-a657-4f1c-965b-8ba94b91c20b/20b8582d-6beb-4161-b157-f7d2bf290963.png",
        "status": 1,
        "type": 1,
        "verified": true
      }
    ],
  },
  "message_code": "M200",
  "message": "Success"
}

Tên	Kiểu dữ liệu	Mô tả
message_code	string	Mã thông điệp. Xem chi tiết
message	string	Nội dung mã thông điệp
data.users	array	Danh sách thông tin các user đã được tạo hoặc cập nhật
data.users[i].user_id	string	ID duy nhất của user (ID bên hệ thống của bạn)
data.users[i].ext_user_id	string	ID duy nhất của user do Piscale tự sinh, mapping 1:1 với user_id
data.users[i].tenant_id	string	Tenant ID của user (ID bên hệ thống của bạn)
data.users[i].ext_tenant_id	string	Tenant ID do Piscale tự sinh, mapping 1:1 với tenant_id
data.users[i].display_name	string	Tên hiển thị
data.users[i].alias	string	Tên khác
data.users[i].avatar_url	string	Đường dẫn dùng để hiển thị avatar
data.users[i].status	number	Trạng thái của user. 1: ACTIVE, 2: INACTIVE
data.users[i].type	number	Loại user. 1: USER, 2: BOT
data.users[i].verified	bool	User được xác thực hay không